home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d5 / mjstuff.arc / MJSHELL.DOC < prev    next >
Encoding:
Text File  |  1990-07-27  |  10.3 KB  |  292 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                             MJSHELL 1.0
  7.  
  8.                                 by
  9.  
  10.                          Cedric Silvester
  11.  
  12.             ╓─────────────────────────────────────────────╖
  13.             ║ (c) Copyright 1990 Dragon's Hoard Software  ║
  14.             ╙─────────────────────────────────────────────╜
  15.  
  16.  
  17. ╓────────────────────╖
  18. ║  What is MJSHELL?  ║
  19. ╙────────────────────╜
  20.  
  21.     MJShell is shell used to manage tile sets for Mahjongg 3.3.
  22.     MJShell allows you to compress all your tile sets into one
  23.     library, using the popular PKZIP(tm) program, and allows you
  24.     to access any tile set, as well as set Mahjongg 3.3 options
  25.     without having to remember command-line switches or
  26.     complicated batch files.
  27.  
  28.  
  29. ╓──────────────────────────╖
  30. ║  What is Mahjongg 3.3 ?  ║
  31. ╙──────────────────────────╜
  32.  
  33.     Mahjongg 3.3 is a pattern-matching game written by Nels
  34.     Anderson.  (PLEASE NOTE: I am in no way associated with Nels
  35.     Anderson.  MJShell is the work of a great fan and envious
  36.     programmer.)  The original tile game (played without a
  37.     computer, if one can imagine!) consisted of 144 wooden or
  38.     stone tiles, each inscribed with an Oriental symbol. The
  39.     object of the game is to remove all the tiles by pairs,
  40.     following a few basic rules.
  41.  
  42.     My main gripe about Mahjongg is that the symbols on the tiles
  43.     don't make a lot of sense.  With the release of Mahjongg 3.3
  44.     came a tile editor, a seemingly innocent enough device
  45.     enabling Mahjongg players to create their own tiles for use
  46.     in the game.  There seems to be no limit to the possible
  47.     subjects for tiles.  To date, I have collected over 50
  48.     different sets, including (but hardly limited to) Beer Can
  49.     Labels, Teddy Bears, Body Parts (G-rated), United States
  50.     Marine Corps, and Flags of the World.  The mind reels...
  51.  
  52.     While the tile editor makes Mahjongg 3.3 a truly great
  53.     program, there are still a few problems...
  54.  
  55.     1) The tile sets are roughly 32 Kbytes each.  Multiply this
  56.        by 50 and 1.5+ Mbytes of precious hard disk real-estate is
  57.        eaten up by accessory files for one game (albeit, a great
  58.        game, but still...)
  59.  
  60.     2) Accessing the tile sets is accomplished in one of two ways:
  61.  
  62.           1: give Mahjongg a command line switch, specifically:
  63.  
  64.                 MAHJONGG -uFOOBAR.TIL
  65.  
  66.             will load Mahjongg with FOOBAR.TIL.
  67.  
  68.           2: from within Mahjongg 3.3, click on the Setup icon,
  69.              and choose '1'.  You will be prompted for a filename
  70.              of the tile set to use, but there is no list of tile
  71.              sets available.
  72.  
  73.     3) There are a number of command line switches that will
  74.        configure Mahjongg, such as -tx (to play a timed game of x
  75.        minutes) or -y to disable the Y/N prompts when selecting
  76.        tiles.
  77.  
  78.  
  79.     MJShell 1.0 tackles the preceding problems as follows:
  80.  
  81.     Problem 1 - Tile file size.
  82.     ===========================
  83.  
  84.     MJShell uses the popular PKUNZIP(tm) program from PKWare.  You
  85.     are required to compress all your tile sets into a file
  86.     called MJTILES.ZIP, and place that file in the same directory
  87.     as Mahjongg 3.3.  Tile sets will compress an average of 80%,
  88.     saving precious hard disk space.
  89.     
  90.     Problem 2 - Accessing different tile sets
  91.     =========================================
  92.  
  93.     When MJShell is run, it looks in the current directory for
  94.     MJTILES.ZIP.  If found, MJTILES.ZIP is scanned for all
  95.     tile sets.  MJShell then sorts the tile sets, and displays
  96.     a scroll-bar type selector for you to choose a tile set from.
  97.  
  98.     * Note *  MJShell 1.0 supports 5 columns of 19, or 90 tile
  99.               sets.  I assume that few people will exceed 90 tile
  100.               sets. Support for more tile sets may be added if
  101.               there is enough interest.
  102.  
  103.      When a tile set is selected MJShell executes PKUNZIP(tm),
  104.      extracting the selected tile set, and then Mahjongg 3.3 is
  105.      started with the appropriate switches to tell it to use the
  106.      selected tile set.  When you quit Mahjongg 3.3, the selected
  107.      tile set is erased to conserve disk space.
  108.  
  109.      Problem 3 - Awkward command line switches
  110.      =========================================
  111.  
  112.      Most Mahjongg 3.3 options are configurable from the command
  113.      line via switches.  MJShell allows you to configure some of
  114.      these options with the function keys.
  115.  
  116.      The following options are supported by MJShell:
  117.  
  118.           F1 - Mouse/No Mouse.
  119.  
  120.                Hitting F1 toggles the use of a mouse in Mahjongg
  121.                3.3.  Mahjongg 3.3 will autodetect a mouse if it's
  122.                present, so selecting 'No Mouse' may be ignored if
  123.                you actually do have a mouse installed.  This
  124.                option might help where Mahjongg is unable to
  125.                detect the mouse.
  126.  
  127.           F3 - Prompts/No Prompts
  128.  
  129.                'Prompts' refers to the Y/N confirmation Mahjongg
  130.                3.3 will prompt you with after selecting a pair of
  131.                tiles.  I find it slows the game down too much, so
  132.                I like to turn these prompts off.
  133.  
  134.           F5 - Title Page/No Title Page
  135.  
  136.                Selecting No Title Page allows you to start
  137.                Mahjongg without seeing the title screen.
  138.  
  139.           F7 - Board# xxxxx
  140.  
  141.                On start up, MJShell picks a random number from 1
  142.                to 65535 for the board number.  This option allows
  143.                you to select a specific board number.  Note that
  144.                selecting a board number less than 0  or >65535
  145.                will cause Mahjongg 3.3 to select a random board.
  146.  
  147.           F9 - Time: xx
  148.  
  149.                If you like to play a timed game, use this option
  150.                to select a number of minutes to play.  Note that
  151.                values greater than 29 minutes are set to 29
  152.                minutes, the maximum Mahjongg 3.3 will accept.
  153.  
  154.  
  155.      MJShell defaults
  156.      ================
  157.  
  158.      At start-up, MJShell defaults to Mouse, No Prompts, No Title
  159.      Page, a random board number, and no time limit.
  160.  
  161.  
  162.  
  163. ╓────────────────╖
  164. ║  Installation  ║
  165. ╙────────────────╜
  166.  
  167.     Follow these step to install MJShell 1.0:
  168.  
  169.     1) copy MJSHELL.EXE to the same directory as Mahjongg 3.3
  170.  
  171.     2) Use PKZIP(tm) 1.xx, to compress all your tile files into a
  172.        file named MJTILES.ZIP.  This file MUST be in the same
  173.        directory as Mahjongg 3.3 and MJShell 1.0.
  174.  
  175.        A sample command to accomplish this is:
  176.  
  177.           PKZIP(tm) -a c:\mahj\mjtiles.zip c:\mahj\*.til
  178.  
  179.        (assuming your Mahjongg 3.3 directory is on C: drive in
  180.         the \MAHJ directory.)
  181.  
  182.        (it might be a good idea to rename BLANK.TIL to BLANK.OLD
  183.         before issuing this command.  BLANK.TIL is a blank
  184.         template tile set for use with TILEMAKR.EXE.  Its a real
  185.         head-scratcher to play, too...)
  186.  
  187.     3) Once MJTILES.ZIP is created & tested, you can delete all
  188.        the uncompressed tile sets.  If you should need a tile set
  189.        at a later date, use PKUNZIP(tm) to extract the one you
  190.        need. Consult PKWare's manual for further information.
  191.  
  192.     4) Ensure that PKUNZIP.EXE is in a PATHed directory.  To
  193.        confirm that PKUNZIP.EXE is on your PATH, try to run
  194.        PKUNZIP(tm) from your Mahjongg 3.3 directory.  In other
  195.        words, type:
  196.  
  197.           PKUNZIP
  198.  
  199.        at the DOS prompt.  If PKUNZIP(tm) executes, it is on your
  200.        PATH.  If you get 'Bad command or filename' then
  201.        PKUNZIP.EXE is not in a PATHed directory.  Either copy
  202.        PKUNZIP.EXE into a PATHed directory, or copy PKUNZIP.EXE
  203.        into your Mahjongg 3.3 directory.
  204.  
  205.        For more information about the DOS PATH, consult your DOS
  206.        manual.
  207.  
  208.     5) Type:
  209.  
  210.            MJSHELL
  211.  
  212.        at the DOS prompt.
  213.  
  214.     That's it!  You should be presented with a list of all the
  215.     tile sets stored in the MJTILE.ZIP file.  If there is a
  216.     problem, MJShell will alert you and suggest a remedy.
  217.  
  218.  
  219. ╓──────────────╖
  220. ║  DISCLAIMER  ║
  221. ╙──────────────╜
  222.  
  223.     The author makes no representation or warranties with respect
  224.     to the contents hereof and specifically disclaims any implied
  225.     warranties of merchantability or fitness for any particular
  226.     purpose.  MJShell 1.0 is provided "as is" without warranty of
  227.     any kind, either expressed or implied.
  228.  
  229.     The author shall have no liability or responsibility to you
  230.     or any other person or entity with respect to any loss or
  231.     damage caused by MJShell 1.0, including but not limited to
  232.     any loss of profits, interruption of service, loss of
  233.     business or consequential damages resulting from the use of
  234.     such programs.
  235.  
  236. ╓────────────╖
  237. ║  FREEWARE  ║
  238. ╙────────────╜
  239.  
  240.     MJShell is a 'freeware' program.  It may be copied freely.
  241.     Use it, share it, enjoy it!
  242.  
  243.     I would appreciate any feedback, pro or con.  Please send
  244.     your comments (postcards would be greatly appreciated):
  245.  
  246.            Attn: Cedric Silvester
  247.            Dragon's Hoard Software
  248.            P.O. Box 2376
  249.            PETERBOROUGH, ONT.,
  250.            CANADA
  251.            K9J 7Y8
  252.  
  253.  
  254.     If you access the FidoNet system, address mail to:
  255.  
  256.            1:229/320
  257.            Cedric Silvester
  258.  
  259.  
  260.     MJShell is free.  However, if you would like to recieve all
  261.     the tile sets I have (as of 20 June '90 I have over 50) just
  262.     send $5.00 and a note requesting so.  If you live in the
  263.     US, I will take $5.00 US, the difference between the Canadian
  264.     & US dollar should make up the difference in postage to you.
  265.  
  266.     I will copy my collection of tile sets onto disk (specify
  267.     3.5" if required) along with the latest version of MJShell.
  268.     Possible additions to MJShell are:
  269.  
  270.           - mouse support.
  271.           - support for more than 90 tile sets.
  272.           - user-definable colors, defaults, etc.
  273.           - EGA 43 line mode.
  274.  
  275.  
  276.  
  277. ╓────────────────╖
  278. ║  A FINAL NOTE  ║
  279. ╙────────────────╜
  280.  
  281.     While I am in no way associated with Nels Anderson, (the
  282.     author of Mahjongg 3.3) I would like to encourage anyone
  283.     using Mahjongg 3.3 to register with Mr. Anderson.  His
  284.     software efforts are second to none, in many ways superior to
  285.     commercial offerings.
  286.  
  287.     Please show your support of the Shareware concept by
  288.     registering the Shareware you use!
  289.  
  290.  
  291.  
  292.